Getting Started with the WebWorks Platform

WebWorks Reverb 2.0 output has an AI Assistant built in. Readers open it from the help's menu, ask a question, and get an answer drawn from your published help, with citations that open the passage the answer came from. The Assistant itself is set up on the WebWorks Platform, where you create it, write its Instructions, upload its knowledge, and put it in deployment. In ePublisher, you connect a Reverb 2.0 target to the Assistant and generate the Knowledge Files the Assistant answers from.

This topic covers the ePublisher side. For the Platform side, see the WebWorks Platform help.

The Steps

You need a WebWorks Platform account. To create one, see Create an account and sign in in the WebWorks Platform help.

  1. On the Platform, create an Assistant and copy its Assistant ID. See Add the AI Assistant to Reverb 2.0 help in the WebWorks Platform help, which walks through the whole setup.

  2. In ePublisher, turn on the AI Features settings of your Reverb 2.0 target and paste in the Assistant ID. See Connecting a Target to the Assistant.

  3. Generate the target. ePublisher writes the Knowledge Files beside the output's index.html. See Generating the Knowledge Files.

  4. Upload the Knowledge Files to the Assistant's Knowledge Base. See Upload Knowledge Files from ePublisher.

  5. Put the Assistant in deployment, then publish the output to a web server on one of the Assistant's Origin Domains. See Put an Assistant in deployment.

Connecting a Target to the Assistant

In ePublisher, open Target Settings for the WebWorks Reverb 2.0 target and set the AI Features group:

Setting

Set to

Purpose

Generate Assistant

Enable

Adds the AI Assistant button and tab to the Reverb 2.0 menu, beside Contents and Index.

Assistant ID

The Assistant's ID

Connects the output to that Assistant.

Generate Knowledge Base

Enable

Writes the Knowledge Files on every build.

Generate Knowledge Base Per Parcel

Enable (optional)

Writes one archive per top-level group instead of one for the project, so you replace only the parcels that changed.

Hide AI Tab when file local

Enable (optional)

Hides the Assistant tab when the output is opened from a file, where the Assistant cannot load.

To find the Assistant ID on the Platform, see Connect the Reverb Assistant to Reverb 2.0 help. For a reference description of each setting, see AI Features Settings and AI Features.

A Single Build for Web and Local Use

With Hide AI Tab when file local enabled, the same generated output works in both places. Served over http: or https:, the Assistant tab is visible and works. Opened from a file, for example when the help is installed with a desktop product, the tab is hidden. You do not need two separate builds.

With the setting disabled, output opened from a local file, or from localhost, shows a placeholder assistant marked "Preview only" instead of your Assistant, because the Platform serves an Assistant only to the domains listed under its Origin Domains. The placeholder answers every message locally with setup steps and sends nothing. Your Assistant appears once the output is served from one of its Origin Domains.

One Assistant per Help Set

Give each help set its own Assistant. An Assistant answers from everything in its Knowledge Base, so help sets that share one also share their answers. For help translated into several languages, use one target and one Assistant per language. For more information, see Specifying the Language Used by Targets and, in the WebWorks Platform help, Assistants and languages.

Changes to the Assistant's Instructions, model, avatar, and knowledge reach published help without regenerating it. Regenerate only when the help itself changes, and upload its new Knowledge Files then.

Generating the Knowledge Files

With Generate Knowledge Base enabled, every build of the target writes the Knowledge Files to the output folder, beside index.html:

  • By default, one archive for the project, named knowledge-<project-name>-<generation-hash>.zip.

  • With Generate Knowledge Base Per Parcel enabled, one archive per top-level group (parcel) instead, named knowledge-parcel-<parcel-name>-<generation-hash>.zip.

The <generation-hash> changes on every build, so when you automate uploads, match the archives by a pattern, such as names that begin with knowledge-. After each publish, upload the new archives and remove the ones they replace: an outdated archive left in the Knowledge Base keeps answering with pages you have changed. For what the archives contain, see Knowledge Base Generation.

Citations link readers to the page and section an answer came from through Landmark IDs, which come from your source documents. Give topics and major headings their own aliases or IDs so that those links land on the right section and stay the same from build to build. For more information, see Landmark IDs.

Improving the Answers

The WebWorks Platform help covers what shapes an Assistant's answers:

In published help, each question also carries the page the reader has open: its address and title, the breadcrumb trail, the section the reader has navigated to, and any text the reader has selected. The Platform's Preview tab sends no page, so after you publish, also ask questions from the help pages themselves.

When the Assistant Does Not Appear

When the Assistant cannot load, the Assistant tab shows Assistant Unavailable with the reason, or, on a local file or localhost, a placeholder marked "Preview only". For what each message means, see When the Assistant Cannot Load. For the Platform settings behind the messages, see The Assistant doesn't appear or doesn't answer in the WebWorks Platform help.

Last modified date: 2026-10-29